Cards are a common organizing unit for modern user interfaces (UI). At their core, they’re just rectangular containers with borders and padding. However, when utilized properly to group related information, they help users better digest, engage, and navigate through content. This is why most successful dashboard/UI frameworks make cards a core feature of their component library. This article provides an overview of the API that bslib provides to create Bootstrap cards.
Setup code
To demonstrate that bslib cards work outside of Shiny (i.e., in R Markdown, static HTML, etc), we’ll make repeated use of statically rendered htmlwidgets like plotly and leaflet. Here’s some code to create those widgets:
library(bslib)
library(shiny)
library(htmltools)
library(plotly)
library(leaflet)
plotly_widget <- plot_ly(x = diamonds$cut) %>%
config(displayModeBar = FALSE) %>%
layout(margin = list(t = 0, b = 0, l = 0, r = 0))
leaflet_widget <- leafletOptions(attributionControl = FALSE) %>%
leaflet(options = .) %>%
addTiles()Shiny usage
Cards work equally well in Shiny. In the
examples below, replace plotly_widget with
plotlyOutput() and leaflet_widget with
leafletOutput() to adapt them for Shiny server-rendered
plots/maps.
Hello card()
A card() is designed to handle any number of “known”
card items (e.g., card_header(), card_body(),
etc) as unnamed arguments (i.e., children). As we’ll see shortly,
card() also has some useful named arguments (e.g.,
full_screen, height, etc).
At their core, card() and card items are just an HTML
div() with a special Bootstrap class, so you can use
Bootstrap’s utility classes to customize things like colors,
text, borders,
etc.
card(
card_header(
class = "bg-dark",
"A header"
),
card_body(
markdown("Some text with a [link](https://github.com)")
)
)Some text with a link
Implicit card_body()
If you find yourself using card_body() without changing
any of its defaults, consider dropping it altogether since any direct
children of card() that aren’t “known” card()
items, are wrapped together into an implicit card_body()
call.1
For example, the code to the right generates HTML that is identical to
the previous example:
card(
card_header(
class = "bg-dark",
"A header"
),
markdown("Some text with a [link](https://github.com).")
)Some text with a link.
Restricting growth
By default, a card()’s size grows to accommodate the
size of its contents. Thus, if a card_body() contains a
large amount of text, tables, etc., you may want to specify a
height or max_height. That said, when laying
out multiple cards, it’s likely best not
to specify height on the card(), and instead, let the
layout determine the height layout_column_wrap().
Although scrolling is convenient for reducing the amount of space
required to park lots of content, it can also be a nuisance to the user.
To help reduce the need for scrolling, consider pairing scrolling with
full_screen = TRUE (which adds an icon to expand the card’s
size to the browser window). Notice how, when the card is expanded to
full-screen, max_height/height won’t effect
the full-screen size of the card.
card(
max_height = 250,
full_screen = TRUE,
card_header(
"A long, scrolling, description"
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)Consectetur neque proin auctor, primis ultricies sed ultrices eros. Ante cras, neque, dignissim neque cubilia vestibulum praesent parturient purus? Pulvinar hac neque neque taciti pellentesque porta habitant! Nisi metus tellus taciti; potenti risus egestas porta luctus nibh. Dictumst laoreet maecenas magna scelerisque, lacinia nulla conubia interdum massa cum justo class.
Elit commodo integer semper laoreet turpis torquent volutpat mus platea aliquam donec: class ultrices! Urna habitasse ultrices gravida lobortis nam. Eleifend aenean auctor, fusce quam, tellus viverra ut eget ornare rhoncus. Litora habitant tristique quisque nostra, viverra enim. Nullam per ut natoque nostra sed laoreet dignissim risus sed.
Lorem duis aptent cras, turpis, mi nunc nostra. Venenatis quam pulvinar dictumst faucibus ac facilisi commodo pretium. Nulla sodales duis auctor eros rutrum tempus et: per – massa sollicitudin urna conubia donec. Volutpat nulla scelerisque risus imperdiet cursus quisque rutrum ac per dictumst? Posuere aliquam nulla, bibendum sem fusce.
Filling outputs
A card()’s default behavior is optimized for
facilitating filling layouts. More
specifically, if a fill item (e.g.,
plotly_widget), appears as a direct child of a
card_body(), it resizes to fit the card()s
specified height. This means, by specifying height = 250
we’ve effectively shrunk the plot’s height from its default of 400 down
to about 200 pixels. And, when expanded to full_screen, the
plot grows to match the card()’s new size.
card(
height = 250,
full_screen = TRUE,
card_header("A filling plot"),
card_body(plotly_widget)
)Most htmlwidgets (e.g., plotly, leaflet, etc) and some other Shiny
output bindings (e.g, plotOutput(),
imageOutput(), etc) are fill items by
default, so this behavior “just works” in those scenarios. And, in some
of these situations, it’s helpful to remove card_body()’s
padding, which can be done via spacing
& alignment utility classes.
card(
height = 275,
full_screen = TRUE,
card_header("A filling map"),
card_body(
class = "p-0",
leaflet_widget
),
card_footer(
class = "fs-6",
"Copyright 2023 RStudio, PBC"
)
)Fill item(s) aren’t limited in how much they grow
and shrink, which can be problematic when a card becomes very small. To
work around this, consider adding a min_height on the
card_body() container. For example, try using the handle on
the lower-right portion of this card example to make the card
taller/smaller.
This interactive example is a bit contrived in that we’re using CSS
resize to demonstrate how to make plots that don’t shrink beyond a
certain point, but this concept becomes quite useful when implementing
page-level filling layouts (i.e.,
page_fillable()) with multiple
cards.
card(
height = 300,
style = "resize:vertical;",
card_header("Plots that grow but don't shrink"),
card_body(
min_height = 250,
plotly_widget,
plotly_widget
)
)Troubleshooting fill
As you’ll learn more about in filling
layouts, a fill item loses its ability to fill when
wrapped in additional UI element that isn’t a fillable
container. To fix the situation, use as_fill_carrier() to
allow the additional element to carry the potential to fill from the
card_body() down to the fill item.
Multiple card_body()
A card() can have multiple card_body()s,
which is especially useful for:
- Combining both resizable and non-resizable contents (i.e., fill items and non-fill).
- Allowing each
card_body()to have their own styling (via inline styles and/or utility classes) and resizing limits (e.g.,min_height).
For example, when pairing filling output with scrolling content, you
may want min_height on the filling output since the
scrolling content will force it to shrink:
card(
height = 375,
full_screen = TRUE,
card_header(
"Filling plot, scrolling description"
),
card_body(
min_height = 200,
plotly_widget
),
card_body(
class = "lead container",
lorem::ipsum(paragraphs = 10, sentences = 5)
)
)Amet cum malesuada erat potenti tortor sociis hendrerit auctor massa neque mauris. Malesuada tortor sociosqu porttitor nam laoreet felis nulla nisl montes! Lobortis accumsan eget ac potenti aptent – tempus nullam sociosqu? Aptent curabitur pretium hac penatibus: odio euismod – vivamus montes mollis. In elementum vehicula eleifend facilisi integer, pulvinar sapien ligula quisque.
Lorem bibendum tellus, sagittis ornare eleifend odio, potenti nec bibendum habitasse. Tempor interdum id pellentesque hendrerit dictum: habitant sodales pretium imperdiet bibendum venenatis donec. Dignissim aliquet dis metus nostra praesent tristique eleifend rutrum? Varius felis potenti nisl quis, dictumst primis nunc id. In condimentum netus fringilla ridiculus.
Sit conubia at sociosqu volutpat ad, placerat vulputate laoreet cras? Varius nulla libero hac velit phasellus congue, quisque nulla pharetra. Lobortis per eros euismod, sagittis taciti iaculis arcu vehicula cum. Consequat porta habitant diam felis aptent pellentesque nibh ac in. Blandit pellentesque condimentum tellus faucibus hac cum molestie ultrices etiam rhoncus egestas?
Ipsum fermentum netus convallis potenti pretium: eu eget ut viverra? Praesent ultrices est; pellentesque eleifend vitae nisi – torquent eleifend. Metus varius egestas accumsan vestibulum leo! Suscipit ut et fermentum lacinia, orci, vulputate risus rhoncus praesent facilisis. Blandit vivamus fames ac luctus nibh phasellus rhoncus pulvinar, donec et vulputate, nostra ridiculus blandit auctor hac, facilisi class mattis pretium?
Adipiscing lectus himenaeos gravida cum sociis duis dis tortor. Netus pretium cursus quisque vitae aliquam, iaculis curabitur dis! Himenaeos volutpat vitae senectus lectus sociis dictum nulla. Facilisi cubilia est quis facilisi bibendum, neque iaculis ridiculus sed posuere? Aliquam inceptos mollis eros faucibus, turpis fermentum viverra lobortis erat turpis nisl tempus vivamus.
Adipiscing sem congue pretium lectus penatibus proin urna laoreet molestie penatibus. Facilisi ut curabitur curabitur fringilla primis odio iaculis himenaeos. Pellentesque sapien venenatis proin vitae ante at. Pharetra metus ornare turpis odio dictum. Vel leo lobortis, nullam fermentum, iaculis venenatis eros vitae maecenas sed phasellus.
Consectetur ut sociis fringilla sapien dapibus facilisis suspendisse. Mattis tempus quisque sem; porttitor arcu nibh ultrices leo? Sem risus faucibus habitasse, faucibus penatibus pellentesque augue justo. Montes aliquam penatibus quis cras pharetra, nibh urna condimentum mus quisque. Lacus dictumst fames aliquet hendrerit et, rutrum nam – porta turpis molestie est, proin cursus per sodales.
Elit dignissim varius integer elementum accumsan; senectus aptent fermentum felis class! Ornare nulla habitant mauris orci. Massa mollis tortor: orci ullamcorper quisque eu? Felis curabitur facilisis risus libero facilisi mattis ridiculus urna condimentum id interdum, integer proin. Sociosqu accumsan neque habitasse sagittis posuere nullam suspendisse porttitor erat proin, natoque; netus dapibus sed interdum magna vehicula sed litora lectus, sollicitudin felis rutrum!
Ipsum habitasse, ad condimentum tincidunt viverra rutrum quis mi. Nec congue scelerisque aenean pellentesque taciti tempus id quisque cras – odio leo porttitor blandit pretium nec magna! Netus sollicitudin imperdiet iaculis hac sem mauris fusce ac pellentesque quisque? Magna taciti inceptos lectus sed commodo sed aenean cras turpis. Eget purus est.
Amet dis; fusce himenaeos neque quisque mollis imperdiet, aliquet posuere curabitur nostra. Suspendisse mollis maecenas condimentum malesuada – magna duis dui, porttitor mollis? Massa est congue porttitor suscipit dis fusce ut turpis. Purus nulla nostra non. Hac integer sodales aenean maecenas augue condimentum posuere – tempus tortor, integer purus tortor aenean quis suspendisse diam vel.
Also, when the content has a fixed size, and should not be allowed to
scroll, set fill = FALSE:
card(
height = 350,
full_screen = TRUE,
card_header(
"Filling plot, short description"
),
plotly_widget,
card_body(
fill = FALSE, gap = 0,
card_title("A subtitle"),
p(class = "text-muted", "And a caption")
)
)A subtitle
And a caption
Multiple columns
As you’ll learn in column-based
layouts, layout_column_wrap() is great for multi-column
layouts that are responsive and accommodate for filling output. Here we have an equal-width
2-column layout using width = 1/2, but it’s also possible
to have varying column
widths.
card(
height = 350,
full_screen = TRUE,
card_header("A multi-column filling layout"),
card_body(
min_height = 200,
layout_column_wrap(
width = 1/2,
plotOutput("p1"),
plotOutput("p2")
)
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)Sit ut rhoncus molestie odio elementum potenti sociosqu lacinia metus erat! Interdum tempor leo integer, porta est leo justo ligula eleifend donec. Aliquam est mus sem ultrices augue dictum aptent, aliquet fusce dictumst at. Aptent odio tristique semper laoreet ut neque cubilia commodo nullam odio: luctus velit sem. Suscipit mattis, potenti felis scelerisque enim, eros nisi donec.
Dolor ac primis pulvinar egestas vitae, vulputate, vitae lacinia nam vivamus turpis bibendum. Varius cubilia velit feugiat, et, fusce diam porta. Curabitur eget habitant accumsan mi cum euismod, ullamcorper proin arcu? Rutrum urna, non sapien lectus mauris integer. Odio tortor augue faucibus fusce sociis – sociosqu diam nisi magnis per, nam mus per sed mollis semper – enim cubilia curabitur molestie: porttitor suspendisse mus nascetur ac pulvinar!
Adipiscing nascetur diam metus, cursus aptent; sollicitudin ullamcorper risus hac congue. Mus tempus justo vulputate, neque, erat, habitasse nunc. Mollis mattis tincidunt placerat duis penatibus, mattis donec imperdiet pretium. Tristique ac sociis tortor id viverra inceptos praesent elementum. Inceptos nisi himenaeos porttitor ridiculus blandit; felis dui taciti curabitur eleifend suscipit varius eleifend est elementum sem, laoreet dictumst faucibus?
Multiple cards
layout_column_wrap() is especially nice for laying out
multiple cards since each card in a particular row will have the same
height (by default). Learn more in column-based layouts.
layout_column_wrap(
width = 1/2,
height = 300,
card(full_screen = TRUE, card_header("A filling plot"), plotly_widget),
card(full_screen = TRUE, card_header("A filling map"), card_body(class = "p-0", leaflet_widget))
)Multiple tabs
navset_card_tab() and navset_card_pill()
make it possible to create cards with multiple tabs or pills. These
functions have the same full_screen capabilities as normal
card()s as well some other options like title
(since there is no natural place for a card_header() to be
used). Note that, each nav_panel() object is similar to a
card(). That is, if the direct children aren’t already card
items (e.g., card_title()), they get implicitly wrapped in a
card_body().
library(leaflet)
navset_card_tab(
height = 450,
full_screen = TRUE,
title = "HTML Widgets",
nav_panel(
"Plotly",
card_title("A plotly plot"),
plotly_widget
),
nav_panel(
"Leaflet",
card_title("A leaflet plot"),
leaflet_widget
),
nav_panel(
shiny::icon("circle-info"),
markdown("Learn more about [htmlwidgets](http://www.htmlwidgets.org/)")
)
)Sidebars
As you’ll learn more about in sidebar
layouts, layout_sidebar() just works when placed inside
in a card(). In this case, if you want fill
items (e.g., plotly_widget) to still fill the card
like we’ve seen before, you’ll need to
set fillable = TRUE in layout_sidebar().
card(
height = 300,
full_screen = TRUE,
card_header("A sidebar layout inside a card"),
layout_sidebar(
fillable = TRUE,
sidebar = sidebar(
actionButton("btn", "A button")
),
plotly_widget
)
)Static images
card_image() makes it easy to embed static (i.e.,
pre-generated) images into a card. Provide a URL to href to
make it clickable. In the case of multiple card_image()s,
consider laying them out in multiple cards
with layout_column_wrap() to produce a grid of clickable
thumbnails.
card(
height = 300,
full_screen = TRUE,
card_image(
file = "shiny-hex.svg",
href = "https://github.com/rstudio/shiny"
),
card_body(
fill = FALSE,
card_title("Shiny for R"),
p(
class = "fw-light text-muted",
"Brought to you by RStudio."
)
)
)
Shiny for R
Brought to you by RStudio.
Flexbox
Both card() and card_body() default to
fillable = TRUE (that is, they are CSS flexbox
containers), which works wonders for facilitating filling outputs, but it also leads to
surprising behavior with inline tags (e.g., actionButton(),
span(), strings, etc). Specifically, each inline tag is
placed on a new line, but in a “normal” layout flow
(fillable = FALSE), inline tags render inline.
card(
card_body(
fillable = TRUE,
"Here's some", tags$i("inline"), "text",
actionButton("btn1", "A button")
),
card_body(
fillable = FALSE,
"Here's some", tags$i("inline"), "text",
actionButton("btn2", "A button")
)
)That said, sometimes working in a flexbox layout is quite useful,
even when working with inline tags. Here we leverage flexbox’s gap
property to control the spacing between a plot, a (full-width) button,
and paragraph. Note that, by using markdown() for the
paragraph, it wraps the results in a <p> tag, which
means the contents of the paragraph are not longer subject to
flexbox layout. If we wanted, we could do something similar to render
the actionButton() inline by wrapping it in a
div().
card(
height = 325, full_screen = TRUE,
card_header("A plot with an action links"),
card_body(
class = "gap-2 container",
plotly_widget,
actionButton(
"go_btn", "Action button",
class = "btn-primary rounded-0"
),
markdown("Here's a _simple_ [hyperlink](https://www.google.com/).")
)
)In addition to gap, flexbox has really nice ways of handling otherwise difficult spacing and alignment issues. And, thanks to Bootstrap’s flex utility classes, we can easily opt-in and customize defaults.
card(
height = 300, full_screen = TRUE,
card_header(
class = "d-flex justify-content-between",
"Centered plot",
checkboxInput("check", " Check me", TRUE)
),
card_body(
class = "align-items-center",
plotOutput("id", width = "75%")
)
)Shiny
Since this article is statically rendered, the examples here use
statically rendered content/widgets, but the same card()
functionality works for dynamically rendered content via Shiny (e.g.,
plotOutput(), plotlyOutput(), etc).
An additional benefit that comes with using shiny is the ability to
use getCurrentOutputInfo() to render new/different content
when the output container becomes large enough, which is particularly
useful with card(full_screen = T, ...). For example, you
may want additional captions/labels when a plot is large, additional
controls on a table, etc (see the value
boxes article for a clever use of this).
# UI logic
ui <- page_fluid(
card(
max_height = 200,
full_screen = TRUE,
card_header("A dynamically rendered plot"),
plotOutput("plot_id")
)
)
# Server logic
server <- function(input, output, session) {
output$plot_id <- renderPlot({
info <- getCurrentOutputInfo()
if (info$height() > 600) {
# code for "large" plot
} else {
# code for "small" plot
}
})
}
shinyApp(ui, server)Appendix
The following CSS is used to give plotOutput() a
background color; it’s necessary here because this documentation page is
not actually hooked up to a Shiny app, so we can’t show a real plot.